feat(ModalDialog): add constraints between parameters #5471

ArgoZhang · 2025-02-28T16:26:07Z

add constraints between parameters

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符；如果有关联 Issue 请在下方填写相关编号

Description

fixes #5470

Regression?

Yes
No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

High
Medium
Low

[Justify the selection above]

Verification

Manual (required)
Automated

Packaging changes reviewed?

Yes
No
N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

Doc is updated/provided or not needed
Demo is updated/provided or not needed
Merge the latest code from the main branch

This pull request includes several updates to the DialogOption and ModalDialog components to improve functionality and ensure proper behavior when certain properties are set. The changes include adding remarks to property setters and updating logic to disable certain features based on property values.

Key changes:

Updates to `DialogOption` Component:

Added remarks to the FullScreenSize property to indicate that setting this value disables ShowMaximizeButton, ShowResize, and IsDraggable. (src/BootstrapBlazor/Components/Dialog/DialogOption.cs, src/BootstrapBlazor/Components/Dialog/DialogOption.csR36-R42)
Added remarks to the ShowMaximizeButton property to indicate that setting this value to true disables ShowResize and IsDraggable. (src/BootstrapBlazor/Components/Dialog/DialogOption.cs, src/BootstrapBlazor/Components/Dialog/DialogOption.csR36-R42)

Updates to `ModalDialog` Component:

Added remarks to the FullScreenSize property to indicate that setting this value disables ShowMaximizeButton, ShowResize, and IsDraggable. (src/BootstrapBlazor/Components/Modal/ModalDialog.razor.cs, src/BootstrapBlazor/Components/Modal/ModalDialog.razor.csR64)
Added remarks to the ShowMaximizeButton property to indicate that setting this value to true disables ShowResize and IsDraggable. (src/BootstrapBlazor/Components/Modal/ModalDialog.razor.cs, src/BootstrapBlazor/Components/Modal/ModalDialog.razor.csR89)
Updated OnParametersSet method to enforce the disabling of ShowMaximizeButton, ShowResize, and IsDraggable based on the values of FullScreenSize and ShowMaximizeButton. (src/BootstrapBlazor/Components/Modal/ModalDialog.razor.cs, src/BootstrapBlazor/Components/Modal/ModalDialog.razor.csR334-R345)

Test Adjustments:

Updated unit test to reflect the change in behavior when ShowMaximizeButton is set, ensuring ShowResize is disabled. (test/UnitTest/Components/DialogTest.cs, test/UnitTest/Components/DialogTest.csL67-R69)

Summary by Sourcery

Adds constraints to the ModalDialog and DialogOption components to disable ShowResize and IsDraggable when FullScreenSize is set or ShowMaximizeButton is enabled. Also, updates the unit test to reflect the change in behavior when ShowMaximizeButton is set, ensuring ShowResize is disabled.

Enhancements:

Adds remarks to the FullScreenSize and ShowMaximizeButton properties in DialogOption and ModalDialog to indicate that setting these values disables other properties.
Updates OnParametersSet method to enforce the disabling of ShowMaximizeButton, ShowResize, and IsDraggable based on the values of FullScreenSize and ShowMaximizeButton.

Tests:

Updates unit test to reflect the change in behavior when ShowMaximizeButton is set, ensuring ShowResize is disabled.

sourcery-ai · 2025-02-28T16:26:12Z

Reviewer's Guide by Sourcery

This pull request adds constraints between parameters in the DialogOption and ModalDialog components. It ensures that certain properties are disabled when others are set to maintain functionality.

Sequence diagram for OnParametersSet method in ModalDialog

sequenceDiagram
    participant ModalDialog

    ModalDialog->ModalDialog: OnParametersSet()
    alt FullScreenSize != FullScreenSize.None
        ModalDialog->ModalDialog: ShowMaximizeButton = false
        ModalDialog->ModalDialog: ShowResize = false
        ModalDialog->ModalDialog: IsDraggable = false
    else ShowMaximizeButton == true
        ModalDialog->ModalDialog: ShowResize = false
        ModalDialog->ModalDialog: IsDraggable = false
    end

File-Level Changes

Change	Details	Files
Added remarks to the `FullScreenSize` and `ShowMaximizeButton` properties in `DialogOption` to indicate that setting these values disables other properties.	Added remarks to `FullScreenSize` indicating it disables `ShowMaximizeButton`, `ShowResize`, and `IsDraggable`. Added remarks to `ShowMaximizeButton` indicating it disables `ShowResize` and `IsDraggable`.	`src/BootstrapBlazor/Components/Dialog/DialogOption.cs`
Added remarks to the `FullScreenSize` and `ShowMaximizeButton` properties in `ModalDialog` and updated the `OnParametersSet` method to enforce disabling of properties based on `FullScreenSize` and `ShowMaximizeButton` values.	Added remarks to `FullScreenSize` indicating it disables `ShowMaximizeButton`, `ShowResize`, and `IsDraggable`. Added remarks to `ShowMaximizeButton` indicating it disables `ShowResize` and `IsDraggable`. Updated `OnParametersSet` to disable `ShowMaximizeButton`, `ShowResize`, and `IsDraggable` based on `FullScreenSize`. Updated `OnParametersSet` to disable `ShowResize` and `IsDraggable` based on `ShowMaximizeButton`.	`src/BootstrapBlazor/Components/Modal/ModalDialog.razor.cs`
Updated unit test to reflect the change in behavior when `ShowMaximizeButton` is set, ensuring `ShowResize` is disabled.	Updated assertion to check that the resize button is not present when `ShowMaximizeButton` is set.	`test/UnitTest/Components/DialogTest.cs`

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#5470	Add constraints between parameters of the ModalDialog and DialogOption components to ensure proper behavior when certain properties are set, specifically disabling ShowMaximizeButton, ShowResize, and IsDraggable based on the values of FullScreenSize and ShowMaximizeButton.	✅

Possibly linked issues

feat(ModalDialog): add constraints between parameters #5470: The PR adds constraints between parameters for the ModalDialog component, addressing the issue.
feat(ModalDialog): add constraints between parameters #5470: The PR fixes the issue by adding constraints between IsDraggable and IsCentered parameters so that the modal dialog can be centered correctly.

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider extracting the logic that disables properties based on FullScreenSize and ShowMaximizeButton into a separate method for better readability.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟡 Testing: 1 issue found
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

test/UnitTest/Components/DialogTest.cs

codecov · 2025-02-28T16:28:58Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (a56d358) to head (38f77ee).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #5471   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          646       646           
  Lines        29362     29373   +11     
  Branches      4132      4134    +2     
=========================================
+ Hits         29362     29373   +11

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ArgoZhang added 3 commits March 1, 2025 00:12

refactor: 增加文档注释

606f67b

feat: 增加参数约束逻辑

01b9ad4

test: 更新单元测试

38f77ee

bb-auto bot assigned ArgoZhang Feb 28, 2025

bb-auto bot added the enhancement New feature or request label Feb 28, 2025

bb-auto bot added this to the v9.3.0 milestone Feb 28, 2025

sourcery-ai bot approved these changes Feb 28, 2025

View reviewed changes

test/UnitTest/Components/DialogTest.cs Show resolved Hide resolved

ArgoZhang merged commit b4c8c68 into main Feb 28, 2025
6 checks passed

ArgoZhang deleted the feat-modal branch February 28, 2025 16:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(ModalDialog): add constraints between parameters #5471

feat(ModalDialog): add constraints between parameters #5471

Uh oh!

ArgoZhang commented Feb 28, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Feb 28, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

codecov bot commented Feb 28, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

feat(ModalDialog): add constraints between parameters #5471

feat(ModalDialog): add constraints between parameters #5471

Uh oh!

Conversation

ArgoZhang commented Feb 28, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

add constraints between parameters

Description

Regression?

Risk

Verification

Packaging changes reviewed?

☑️ Self Check before Merge

Updates to DialogOption Component:

Updates to ModalDialog Component:

Test Adjustments:

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Feb 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Sequence diagram for OnParametersSet method in ModalDialog

File-Level Changes

Assessment against linked issues

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented Feb 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ArgoZhang commented Feb 28, 2025 •

edited by sourcery-ai bot

Loading

Updates to `DialogOption` Component:

Updates to `ModalDialog` Component:

sourcery-ai bot commented Feb 28, 2025 •

edited

Loading

codecov bot commented Feb 28, 2025 •

edited

Loading